<!DOCTYPE html>
<html  >
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="keywords" content="teedoc, markdown, syntax">
    <meta name="description" content="teedoc's markdown syntax introduction and examples">
    <meta name="generator" content="teedoc">
    <meta name="markdown-generator" content="teedoc-plugin-markdown-parser">
        <link rel="stylesheet" href="/static/css/theme_default/prism.min.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/theme_default/dark.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/theme_default/light.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/custom.css" type="text/css"/>
        <script src="/static/js/theme_default/jquery.min.js"></script>
        <script src="/static/js/theme_default/pre_main.js"></script>
        <link rel="stylesheet" href="/static/css/search/style.css" type="text/css"/>
        <script>
var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://hm.baidu.com/hm.js?91ac08174b63c5c88f71f8a94004a1fe";
  var s = document.getElementsByTagName("script")[0]; 
  s.parentNode.insertBefore(hm, s);
})();
</script>
    <title>markdown syntax - teedoc</title>
</head>
<body>
    
            <div id="navbar">
                <div id="navbar_menu">
                    <a class="site_title" href="/en/"><img class="site_logo" src="/static/image/logo.png" alt="teedoc logo"><h2>teedoc</h2></a>
                    <a id="navbar_menu_btn"></a>
                </div>
                <div id="navbar_items">
                    <div>
                        <ul id="nav_left">
<li class="active"><a  href="/get_started/en/">Install</a></li>
<li class=""><a  href="/develop/en/">Develop</a></li>
</ul>

                    </div>
                    <div>
                        <ul id="nav_right">
<li class=""><a target="_blank" href="https://github.com/neutree/teedoc">github</a></li>
<li class="sub_items "><a  href="">语言: English</a><ul><li class=""><a  href="/get_started/zh/">中文</a></li>
<li class="active"><a  href="/get_started/en/">English</a></li>
</ul></li>
</ul>

                        <ul class="nav_plugins"><li><a id="themes" class="light"></a></li></ul><ul class="nav_plugins"><li><a id="search"><span class="icon"></span><span class="placeholder">Search</span>
                            <div id="search_hints">
                                <span id="search_input_hint">Keywords separated by space</span>
                                <span id="search_loading_hint">Loading, wait please ...</span>
                                <span id="search_download_err_hint">Download error, please check network and refresh again</span>
                                <span id="search_other_docs_result_hint">Result from other docs</span>
                                <span id="search_curr_doc_result_hint">Result from current doc</span>
                            </div></a></li></ul>
                    </div>
                </div>
            </div>
    
        <div id="wrapper">
            
            <div id="sidebar_wrapper">
                <div id="sidebar">
                    <div id="sidebar_title">
                        
                    </div>
                    <ul class="show">
<li class="not_active with_link"><a href="/get_started/en/index.html"><span class="label">Introduction to teedoc</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/install/index.html"><span class="label">Install teedoc</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/start.html"><span class="label">Start writing document</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/write_attention.html"><span class="label">Pay attention to when writing documents</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/plugins/index.html"><span class="label">Plugin</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/plugins/themes.html"><span class="label">Theme Plugin</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/plugins/others.html"><span class="label">Other plugins</span><span class=""></span></a></li>
</ul>
</li>
<li class="active with_link"><a href="/get_started/en/syntax/syntax_markdown.html"><span class="label">markdown syntax</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy.html"><span class="label">Deployment</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_github_pages.html"><span class="label">Deploy to github</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_nginx.html"><span class="label">Use nginx to deploy to the server</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_cdn.html"><span class="label">Use CDN to accelerate website</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/usage/seo.html"><span class="label">SEO (Optimize for Search Engines)</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/sites.html"><span class="label">Website using teedoc</span><span class=""></span></a></li>
<li class="not_active no_link"><a><span class="label">More samples</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active no_link"><a><span class="label">Second-level subdirectory example</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active no_link"><a><span class="label">Sample three-level sub-directory</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/more/example_docs/doc1.html"><span class="label">Article 1</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/more/example_docs/doc2.html"><span class="label">Article 2</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="https://github.com/teedoc/teedoc" target="_blank"><span class="label">This is a external link</span><span class=""></span></a></li>
</ul>
</li>
</ul>

                </div>
            </div>
            <div id="menu_wrapper">
                                    <div id="menu">
                                    </div>
                                </div>
            <div id="article">
                <div id="content_wrapper">
                    <div id="content_body">
                        <div id="article_title">
                            <h1>markdown syntax</h1>
                        </div>
                        <div id="article_tags">
                            <ul><li>teedoc</li>
<li> markdown</li>
<li> syntax</li>
</ul>
                        </div>
                        <div id="article_content">
                            <p>This article is a document written using <code>Markdown</code>, using the page effect generated by <code>teedoc</code>, see <a href="https://github.com/teedoc/teedoc.github.io/blob/main/docs/ get_started/zh/syntax/syntax_markdown.html">here</a></p>

<h2 id="markdown-basic-file-content-format">Markdown basic file content format</h2>

<p>You need to confirm in <code>site_config.json</code> that there is a <code>markdown</code> parsing plugin enabled, such as <code>teedoc-plugin-markdown-parser</code>.</p>

<p>Create a folder or file in the directory corresponding to <code>config.json</code>, such as <code>get_started/zh/syntax/syntax_markdown.md</code> (<code>README.md</code> will eventually generate <code>index.html</code>), and then write the content:</p>

<h3 id="markdown-header">Markdown header</h3>

<p>Add a header</p>

<pre><code class="markdown language-markdown">---
title: markdown syntax
tags: teedoc, markdown, syntax
keywords: teedoc, markdown, syntax
desc: teedoc's markdown syntax introduction and examples
---
</code></pre>

<p>Use these keys to set article information:</p>

<ul>
<li><code>title</code>: the title of the article</li>
<li><code>keywords</code>: Keywords, multiple keywords are separated by English commas <code>,</code>, will be added to the header of <code>html</code>, which is convenient for search engines to crawl</li>
<li><code>desc</code>: page description, which will be added to the header of <code>html</code> for easy crawling by search engines</li>
<li><code>id</code>: page <code>id</code>, will be added to the <code>html</code> tag, such as <code>&lt;html id="zh_readme"&gt;...&lt;/html&gt;</code>, it can be left unset, it will overwrite <code>config.json</code> Settings in</li>
<li><code>class</code>: page <code>class</code>, multiple separated by English comma<code>,</code>, it is not necessary to set it, it will overwrite the setting in <code>config.json</code>. For example, you can set the <code>css</code> style of a specific page by setting this value</li>
</ul>

<h3 id="markdown-file-content">Markdown file content</h3>

<p>The content is written using the <code>Markdown</code> grammar, because the title will be converted into the <code>&lt;h1&gt;</code> tag, so the content is recommended to start with the secondary title, so that a page has only one <code>&lt;h1&gt;</code> tag, which is convenient for search engines to crawl ,such as</p>

<pre><code class="markdown language-markdown">---
title: teedoc
keywords: teedoc, markdown, jupyter notebook, html, document generation, alternative gitbook, website generation, static website
desc: teedoc, convert markdown or jupyter notbook into html static webpage
id: zh_readme
class: zh_readme
---


## Title One

content. . .

## Title Two

content. . .
</code></pre>

<p>The first-level title (<code>#</code>) is best not to be used, because the above <code>title</code> will automatically generate a first-level title (<code>&lt;h1&gt;</code> tag), and a page should have only one first-level title, which is convenient for search engines to crawl Included</p>

<p><code>keywords</code> is the <code>keywords</code> of the generated <code>html</code> page, which will not be displayed on the page, and is mainly provided to search engines<br />
<code>desc</code> is the <code>description</code> of the generated <code>html</code> page, it will not be displayed on the page, it is mainly provided to search engines<br />
<code>tags</code> are the tags for the article, which will be displayed on the page</p>

<h2 id="secondary-heading">Secondary heading</h2>

<h3 id="three-level-heading">Three-level heading</h3>

<h4 id="four-level-heading">Four-level heading</h4>

<h4 id="four-level-heading-2">Four-level heading 2</h4>

<h4 id="four-level-heading-3">Four-level heading 3</h4>

<h5 id="five-level-heading">Five-level heading</h5>

<h6 id="sixth-level-heading">Sixth level heading</h6>

<p>Up to 6 headings</p>

<h2 id="link">Link</h2>

<p><a href="../index.html">Introduction to teedoc</a></p>

<h2 id="list">List</h2>

<p>List item:</p>

<ul>
<li>Buns</li>
<li>Mantou</li>
<li>Tea eggs</li>
</ul>

<ul>
<li>aaaaaaa<br />
<ul><br />
<li>Secondary list</li><br />
<li>Secondary list</li><br />
<li>Secondary list</li><br />
</ul></li>
<li>bbbbbb</li>
</ul>

<h2 id="code">code</h2>

<p>This is an inline code <code>print("hello")</code>, or emphasizes <code>teedoc</code></p>

<pre><code class="python language-python">print("hello")

print("world")
</code></pre>

<pre><code class="c language-c">#include "stdio.h"

int main()
{
    printf("hello world");
}
</code></pre>

<h2 id="comment-quote-block">Comment (quote block)</h2>

<p>Below is a comment</p>

<blockquote>
  <p>Here is a comment (<code>&lt;blockquote&gt;&lt;/blockquote&gt;</code>)<br />
  This is the second line of the comment</p>
</blockquote>

<pre><code class="python language-python"># Here is the code snippet in the comment
print("hello")
</code></pre>

<blockquote>
  <p>Notes</p>
  
  <blockquote>
    <p>Comment nesting<br />
    Comment nesting</p>
  </blockquote>
</blockquote>

<h2 id="caveat">caveat</h2>

<p>Below is a warning message</p>

<blockquote class="spoiler">
  <p>This is a warning message (<code>&lt;blockquote class="spoiler"&gt;&lt;/blockquote&gt;</code>)</p>
</blockquote>

<h2 id="picture">Picture</h2>

<p>To display this picture, you need to set the key value of <code>route</code> in <code>site_config.json</code></p>

<p><img src="../../assets/images/logo.jpg" alt="This is a picture" /><br />
<img src="../assets/images/logo.jpg" alt="This is an image" /></p>

<p><img src="../../assets/images/logo.jpg" alt="This is a picture" /><img src="../assets/images/logo.jpg" alt="This is a picture" /></p>

<h2 id="video">Video</h2>

<pre><code class="html language-html">&lt;video src="https://****.com/***.mp4" controls="controls" preload="auto"&gt;your brower not support play video&lt;/video&gt;
</code></pre>

<p>There is no video here, so it is blank, just put in the correct video and it can be played</p>

<p><video src="" controls="controls" preload="auto">your brower or site not support play video</video></p>

<h2 id="iframe-embedded-in-webpage">iframe embedded in webpage</h2>

<iframe src="//player.bilibili.com/player.html?aid=52613549&bvid=BV144411J72P&cid=92076022&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen=" true" style="width:43vw;height:34vw;min-width: 85%;"> </iframe>

<h2 id="quote-mark">Quote mark</h2>

<p>I am proud of what I can do. [^Dianfanren]</p>

<p>This will be annotated at the end of the article</p>

<h2 id="underline">Underline</h2>

<p>I am<strike>Tenjin</strike> Assault worker</p>

<h2 id="form">Form</h2>

<table>
<thead>
<tr>
  <th>Header 1</th>
  <th><em>Header</em> 2</th>
</tr>
</thead>
<tbody>
<tr>
  <td><code>Cell 1</code></td>
  <td><a href="http://example.com">Cell 2</a> link</td>
</tr>
<tr>
  <td>Cell 3</td>
  <td><strong>Cell 4</strong></td>
</tr>
</tbody>
</table>

<h2 id="task-list">task list</h2>

<ul>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Task 1</li>
<li><input type="checkbox" class="task-list-item-checkbox" checked disabled> Mission 2</li>
<li><input type="checkbox" class="task-list-item-checkbox" disabled> Mission 3</li>
<li><input type="checkbox" class="task-list-item-checkbox" disabled> Mission 4</li>
</ul>

<div class="footnotes">
<hr />
<ol>
</ol>
</div>

                        </div>
                    </div>
                    <div id="previous_next">
                        <div id="previous">
                            <a href="/get_started/en/plugins/others.html"><span class="icon"></span><span class="label">Other plugins</span></a>
                        </div>
                        <div id="next">
                            <a href="/get_started/en/usage/deploy.html"><span class="label">Deployment</span><span class="icon"></span></a>
                        </div>
                    </div>
                </div>
                <div id="toc">
                    <div>
                        <ul>
  <li><a href="#markdown-basic-file-content-format">Markdown basic file content format</a>
  <ul>
    <li><a href="#markdown-header">Markdown header</a></li>
    <li><a href="#markdown-file-content">Markdown file content</a></li>
  </ul></li>
  <li><a href="#secondary-heading">Secondary heading</a>
  <ul>
    <li><a href="#three-level-heading">Three-level heading</a></li>
  </ul></li>
  <li><a href="#link">Link</a></li>
  <li><a href="#list">List</a></li>
  <li><a href="#code">code</a></li>
  <li><a href="#comment-quote-block">Comment (quote block)</a></li>
  <li><a href="#caveat">caveat</a></li>
  <li><a href="#picture">Picture</a></li>
  <li><a href="#video">Video</a></li>
  <li><a href="#iframe-embedded-in-webpage">iframe embedded in webpage</a></li>
  <li><a href="#quote-mark">Quote mark</a></li>
  <li><a href="#underline">Underline</a></li>
  <li><a href="#form">Form</a></li>
  <li><a href="#task-list">task list</a></li>
</ul>

                    </div>
                </div>
            </div>
        </div>
        <a id="to_top" href="#"></a>
        <div id="doc_footer">
                        
            <div id="footer">
                <div id="footer_top">
                    <ul>
<li><a>Links</a><ul><li><a target="_blank" href="https://github.com/neutree/teedoc">Build with teedoc</a></li>
<li><a target="_blank" href="https://neucrack.com">Copyright © 2021 Neucrack</a></li>
<li><a  href="/sitemap.xml">Sitemap</a></li>
</ul>
</li>
<li><a>Source code</a><ul><li><a target="_blank" href="https://github.com/neutree/teedoc">github</a></li>
<li><a target="_blank" href="https://github.com/teedoc/teedoc.github.io">website source files</a></li>
</ul>
</li>
</ul>

                </div>
                <div id="footer_bottom">
                    <ul>
<li><a target="_blank" href="https://beian.miit.gov.cn">*ICP备********号-1</a></li>
<li><a target="_blank" href="https://beian.miit.gov.cn/#/Integrated/index">*公网安备**************号</a></li>
</ul>

                </div>
            </div>
                    </div>
</body>
<script src="/static/js/theme_default/main.js"></script>
<script src="/static/css/theme_default/prism.min.js"></script>
<script src="/static/js/custom.js"></script>
<script src="/static/js/search/main.js"></script>
</html>
